-
Notifications
You must be signed in to change notification settings - Fork 256
/
CommunicationClientFactoryBase`1.xml
488 lines (487 loc) · 44.6 KB
/
CommunicationClientFactoryBase`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
<Type Name="CommunicationClientFactoryBase<TCommunicationClient>" FullName="Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<TCommunicationClient>">
<TypeSignature Language="C#" Value="public abstract class CommunicationClientFactoryBase<TCommunicationClient> : Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory<TCommunicationClient> where TCommunicationClient : ICommunicationClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit CommunicationClientFactoryBase`1<(class Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient) TCommunicationClient> extends System.Object implements class Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1<!TCommunicationClient>" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class CommunicationClientFactoryBase(Of TCommunicationClient)
Implements ICommunicationClientFactory(Of TCommunicationClient)" />
<TypeSignature Language="F#" Value="type CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> ICommunicationClient)> = class
 interface ICommunicationClientFactory<'CommunicationClient (requires 'CommunicationClient :> ICommunicationClient)>" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TCommunicationClient">
<Constraints>
<InterfaceName>Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory<TCommunicationClient></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TCommunicationClient">The type of communication client</typeparam>
<summary>
Provides the base implementation of ICommunicationClientFactory for creating communication clients to talk to service fabric services. Extend the
CommunicationClientFactoryBase class to create communication clients for custom transport implementations. This class maintains a cache of communication
clients and attempts to reuse the clients for requests to the same service endpoint.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CommunicationClientFactoryBase (Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver servicePartitionResolver = default, System.Collections.Generic.IEnumerable<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> exceptionHandlers = default, string traceId = default);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver servicePartitionResolver, class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> exceptionHandlers, string traceId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.#ctor(Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver,System.Collections.Generic.IEnumerable{Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler},System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (Optional servicePartitionResolver As IServicePartitionResolver = Nothing, Optional exceptionHandlers As IEnumerable(Of IExceptionHandler) = Nothing, Optional traceId As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)> : Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver * seq<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> * string -> Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>" Usage="new Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)> (servicePartitionResolver, exceptionHandlers, traceId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="servicePartitionResolver" Type="Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver" />
<Parameter Name="exceptionHandlers" Type="System.Collections.Generic.IEnumerable<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler>" />
<Parameter Name="traceId" Type="System.String" />
</Parameters>
<Docs>
<param name="servicePartitionResolver">Optional ServicePartitionResolver</param>
<param name="exceptionHandlers">Optional Custom exception handlers for the exceptions on the Client to Service communication channel</param>
<param name="traceId">Identifier to use in diagnostics traces from this component </param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CommunicationClientFactoryBase (bool fireConnectEvents, Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver servicePartitionResolver = default, System.Collections.Generic.IEnumerable<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> exceptionHandlers = default, string traceId = default);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(bool fireConnectEvents, class Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver servicePartitionResolver, class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> exceptionHandlers, string traceId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.#ctor(System.Boolean,Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver,System.Collections.Generic.IEnumerable{Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler},System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (fireConnectEvents As Boolean, Optional servicePartitionResolver As IServicePartitionResolver = Nothing, Optional exceptionHandlers As IEnumerable(Of IExceptionHandler) = Nothing, Optional traceId As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)> : bool * Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver * seq<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> * string -> Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>" Usage="new Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)> (fireConnectEvents, servicePartitionResolver, exceptionHandlers, traceId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="fireConnectEvents" Type="System.Boolean" />
<Parameter Name="servicePartitionResolver" Type="Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver" />
<Parameter Name="exceptionHandlers" Type="System.Collections.Generic.IEnumerable<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler>" />
<Parameter Name="traceId" Type="System.String" />
</Parameters>
<Docs>
<param name="fireConnectEvents">Indicates that this factory should fire ClientConnected/ClientDisconnected events</param>
<param name="servicePartitionResolver">Optional ServicePartitionResolver</param>
<param name="exceptionHandlers">Optional Custom exception handlers for the exceptions on the Client to Service communication channel</param>
<param name="traceId">Identifier to use in diagnostics traces from this component </param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AbortClient">
<MemberSignature Language="C#" Value="protected abstract void AbortClient (TCommunicationClient client);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void AbortClient(!TCommunicationClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.AbortClient(`0)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Sub AbortClient (client As TCommunicationClient)" />
<MemberSignature Language="F#" Value="abstract member AbortClient : 'CommunicationClient -> unit" Usage="communicationClientFactoryBase.AbortClient client" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="TCommunicationClient" />
</Parameters>
<Docs>
<param name="client">Communication client</param>
<summary>
Aborts the given client
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientConnected">
<MemberSignature Language="C#" Value="public event EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>> ClientConnected;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs`1<!TCommunicationClient>> ClientConnected" />
<MemberSignature Language="DocId" Value="E:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.ClientConnected" />
<MemberSignature Language="VB.NET" Value="Public Event ClientConnected As EventHandler(Of CommunicationClientEventArgs(Of TCommunicationClient)) " />
<MemberSignature Language="F#" Value="member this.ClientConnected : EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " Usage="member this.ClientConnected : System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " />
<MemberType>Event</MemberType>
<Implements>
<InterfaceMember>E:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.ClientConnected</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>></ReturnType>
</ReturnValue>
<Docs>
<summary>
Event handler that is fired when the Communication client connects to the service endpoint.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientDisconnected">
<MemberSignature Language="C#" Value="public event EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>> ClientDisconnected;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs`1<!TCommunicationClient>> ClientDisconnected" />
<MemberSignature Language="DocId" Value="E:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.ClientDisconnected" />
<MemberSignature Language="VB.NET" Value="Public Event ClientDisconnected As EventHandler(Of CommunicationClientEventArgs(Of TCommunicationClient)) " />
<MemberSignature Language="F#" Value="member this.ClientDisconnected : EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " Usage="member this.ClientDisconnected : System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " />
<MemberType>Event</MemberType>
<Implements>
<InterfaceMember>E:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.ClientDisconnected</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>></ReturnType>
</ReturnValue>
<Docs>
<summary>
Event handler that is fired when the Communication client disconnects from the service endpoint.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateClientAsync">
<MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task<TCommunicationClient> CreateClientAsync (string endpoint, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!TCommunicationClient> CreateClientAsync(string endpoint, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.CreateClientAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function CreateClientAsync (endpoint As String, cancellationToken As CancellationToken) As Task(Of TCommunicationClient)" />
<MemberSignature Language="F#" Value="abstract member CreateClientAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>" Usage="communicationClientFactoryBase.CreateClientAsync (endpoint, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TCommunicationClient></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="endpoint" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="endpoint">listener address where the replica is listening</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Creates a communication client for the given endpoint address.
</summary>
<returns>The communication client that was created</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public virtual void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="communicationClientFactoryBase.Dispose " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Dispose the managed/unmanaged resouces.
Dispose Method is being added rather than making it IDisposable so that it doesn't change type information and wont be a breaking change.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExceptionHandlers">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> ExceptionHandlers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler> ExceptionHandlers" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.ExceptionHandlers" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExceptionHandlers As IEnumerable(Of IExceptionHandler)" />
<MemberSignature Language="F#" Value="member this.ExceptionHandlers : seq<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler>" Usage="Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>.ExceptionHandlers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceFabric.Services.Communication.Client.IExceptionHandler></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the custom exception handlers for handling exceptions on the client to service communication channel.
</summary>
<value>List of Exception handlers</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClientAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<TCommunicationClient> GetClientAsync (System.Fabric.ResolvedServicePartition previousRsp, Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplica, string listenerName, Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!TCommunicationClient> GetClientAsync(class System.Fabric.ResolvedServicePartition previousRsp, valuetype Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplica, string listenerName, class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.GetClientAsync(System.Fabric.ResolvedServicePartition,Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector,System.String,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClientAsync (previousRsp As ResolvedServicePartition, targetReplica As TargetReplicaSelector, listenerName As String, retrySettings As OperationRetrySettings, cancellationToken As CancellationToken) As Task(Of TCommunicationClient)" />
<MemberSignature Language="F#" Value="abstract member GetClientAsync : System.Fabric.ResolvedServicePartition * Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector * string * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>
override this.GetClientAsync : System.Fabric.ResolvedServicePartition * Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector * string * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>" Usage="communicationClientFactoryBase.GetClientAsync (previousRsp, targetReplica, listenerName, retrySettings, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.GetClientAsync(System.Fabric.ResolvedServicePartition,Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector,System.String,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TCommunicationClient></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="previousRsp" Type="System.Fabric.ResolvedServicePartition" />
<Parameter Name="targetReplica" Type="Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector" />
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="previousRsp">Previous ResolvedServicePartition value</param>
<param name="targetReplica">Specifies which replica in the partition identified by the partition key, the client should connect to</param>
<param name="listenerName">Specifies which listener in the endpoint of the chosen replica, to which the client should connect to</param>
<param name="retrySettings">Specifies the retry policy that should be used for exceptions that occur when creating the client.</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Gets or Creates the CommunicationClient for the specified listener name by resolving based on the given previousRsp.
</summary>
<returns>
A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding operation. The result of the Task is
the CommunicationClient(<see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient" />) object.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClientAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<TCommunicationClient> GetClientAsync (Uri serviceUri, Microsoft.ServiceFabric.Services.Client.ServicePartitionKey partitionKey, Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplicaSelector, string listenerName, Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!TCommunicationClient> GetClientAsync(class System.Uri serviceUri, class Microsoft.ServiceFabric.Services.Client.ServicePartitionKey partitionKey, valuetype Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplicaSelector, string listenerName, class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.GetClientAsync(System.Uri,Microsoft.ServiceFabric.Services.Client.ServicePartitionKey,Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector,System.String,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClientAsync (serviceUri As Uri, partitionKey As ServicePartitionKey, targetReplicaSelector As TargetReplicaSelector, listenerName As String, retrySettings As OperationRetrySettings, cancellationToken As CancellationToken) As Task(Of TCommunicationClient)" />
<MemberSignature Language="F#" Value="abstract member GetClientAsync : Uri * Microsoft.ServiceFabric.Services.Client.ServicePartitionKey * Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector * string * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>
override this.GetClientAsync : Uri * Microsoft.ServiceFabric.Services.Client.ServicePartitionKey * Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector * string * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>" Usage="communicationClientFactoryBase.GetClientAsync (serviceUri, partitionKey, targetReplicaSelector, listenerName, retrySettings, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.GetClientAsync(System.Uri,Microsoft.ServiceFabric.Services.Client.ServicePartitionKey,Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector,System.String,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TCommunicationClient></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="serviceUri" Type="System.Uri" />
<Parameter Name="partitionKey" Type="Microsoft.ServiceFabric.Services.Client.ServicePartitionKey" />
<Parameter Name="targetReplicaSelector" Type="Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector" />
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="serviceUri">Uri of the service to resolve</param>
<param name="partitionKey">Key that identifies the partition to resolve</param>
<param name="targetReplicaSelector">Specifies which replica in the partition identified by the partition key, the client should connect to</param>
<param name="listenerName">Specifies which listener in the endpoint of the chosen replica, to which the client should connect to</param>
<param name="retrySettings">Specifies the retry policy that should be used for exceptions that occur when creating the client.</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Resolves a partition of the specified service containing one or more communication listeners and returns a client to communicate
to the endpoint corresponding to the given listenerName.
The endpoint of the service is of the form - {"Endpoints":{"Listener1":"Endpoint1","Listener2":"Endpoint2" ...}}
</summary>
<returns>
A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding operation. The result of the Task is
the CommunicationClient(<see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient" />) object.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OpenClient">
<MemberSignature Language="C#" Value="protected virtual System.Threading.Tasks.Task OpenClient (TCommunicationClient client, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OpenClient(!TCommunicationClient client, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.OpenClient(`0,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function OpenClient (client As TCommunicationClient, cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="abstract member OpenClient : 'CommunicationClient * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.OpenClient : 'CommunicationClient * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="communicationClientFactoryBase.OpenClient (client, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="TCommunicationClient" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="client">Communication client</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Opens the Communictaion Client
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReportOperationExceptionAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl> ReportOperationExceptionAsync (TCommunicationClient client, Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation exceptionInformation, Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl> ReportOperationExceptionAsync(!TCommunicationClient client, class Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation exceptionInformation, class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.ReportOperationExceptionAsync(`0,Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ReportOperationExceptionAsync (client As TCommunicationClient, exceptionInformation As ExceptionInformation, retrySettings As OperationRetrySettings, cancellationToken As CancellationToken) As Task(Of OperationRetryControl)" />
<MemberSignature Language="F#" Value="abstract member ReportOperationExceptionAsync : 'CommunicationClient * Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl>
override this.ReportOperationExceptionAsync : 'CommunicationClient * Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl>" Usage="communicationClientFactoryBase.ReportOperationExceptionAsync (client, exceptionInformation, retrySettings, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.ReportOperationExceptionAsync(`0,Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="TCommunicationClient" />
<Parameter Name="exceptionInformation" Type="Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation" />
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="client">Communication client</param>
<param name="exceptionInformation">Information about the exception that occurred when communicating with the service.</param>
<param name="retrySettings">Specifies the retry policy that should be used for handling the reported exception.</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Handles the exceptions that occur in the CommunicationClient when sending a message to the Service
</summary>
<returns>
A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding operation. The result of the Task is
a <see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl" /> object that determines
how the retry policy for this exception.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServiceResolver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver ServiceResolver { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver ServiceResolver" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.ServiceResolver" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ServiceResolver As IServicePartitionResolver" />
<MemberSignature Language="F#" Value="member this.ServiceResolver : Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver" Usage="Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>.ServiceResolver" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceFabric.Services.Client.IServicePartitionResolver</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the ServicePartitionResolver used by the client factory for resolving the service endpoint.
</summary>
<value>ServicePartitionResolver</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TraceId">
<MemberSignature Language="C#" Value="protected string TraceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TraceId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.TraceId" />
<MemberSignature Language="VB.NET" Value="Protected ReadOnly Property TraceId As String" />
<MemberSignature Language="F#" Value="member this.TraceId : string" Usage="Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>.TraceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the diagnostics trace identifier for this component.
</summary>
<value>Trace identifier</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValidateClient">
<MemberSignature Language="C#" Value="protected abstract bool ValidateClient (TCommunicationClient client);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool ValidateClient(!TCommunicationClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.ValidateClient(`0)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function ValidateClient (client As TCommunicationClient) As Boolean" />
<MemberSignature Language="F#" Value="abstract member ValidateClient : 'CommunicationClient -> bool" Usage="communicationClientFactoryBase.ValidateClient client" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="TCommunicationClient" />
</Parameters>
<Docs>
<param name="client">the communication client</param>
<summary>
Returns true if the client is still valid. Connection oriented transports can use this method to indicate that the client is no longer
connected to the service.
</summary>
<returns>true if the client is valid, false otherwise</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValidateClient">
<MemberSignature Language="C#" Value="protected abstract bool ValidateClient (string endpoint, TCommunicationClient client);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool ValidateClient(string endpoint, !TCommunicationClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientFactoryBase`1.ValidateClient(System.String,`0)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function ValidateClient (endpoint As String, client As TCommunicationClient) As Boolean" />
<MemberSignature Language="F#" Value="abstract member ValidateClient : string * 'CommunicationClient -> bool" Usage="communicationClientFactoryBase.ValidateClient (endpoint, client)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="endpoint" Type="System.String" />
<Parameter Name="client" Type="TCommunicationClient" />
</Parameters>
<Docs>
<param name="endpoint">Specifies the expected endpoint to which we think the client is connected to</param>
<param name="client">the communication client</param>
<summary>
Returns true if the client is still valid and connected to the endpoint specified in the parameter.
</summary>
<returns>true if the client is valid, false otherwise</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>